<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class template basic_ipstream</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header &lt;boost/process/pipe.hpp&gt;">
<link rel="prev" href="std_err.html" title="Global std_err">
<link rel="next" href="basic_opstream.html" title="Class template basic_opstream">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="std_err.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_opstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.process.basic_ipstream"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_ipstream</span></h2>
<p>boost::process::basic_ipstream</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header &lt;boost/process/pipe.hpp&gt;">boost/process/pipe.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special">&lt;</span><span class="identifier">CharT</span><span class="special">&gt;</span> <span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// types</span>
  <span class="keyword">typedef</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <a name="boost.process.basic_ipstream.pipe_type"></a><span class="identifier">pipe_type</span><span class="special">;</span>  
  <span class="keyword">typedef</span> <span class="identifier">CharT</span>                       <a name="boost.process.basic_ipstream.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>  
  <span class="keyword">typedef</span> <span class="identifier">Traits</span>                      <a name="boost.process.basic_ipstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span>
  <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">int_type</span>            <a name="boost.process.basic_ipstream.int_type"></a><span class="identifier">int_type</span><span class="special">;</span>   
  <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">pos_type</span>            <a name="boost.process.basic_ipstream.pos_type"></a><span class="identifier">pos_type</span><span class="special">;</span>   
  <span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">off_type</span>            <a name="boost.process.basic_ipstream.off_type"></a><span class="identifier">off_type</span><span class="special">;</span>   

  <span class="comment">// <a class="link" href="basic_ipstream.html#boost.process.basic_ipstreamconstruct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="basic_ipstream.html#idm45512231410864-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="basic_ipstream.html#idm45512231410288-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  <a class="link" href="basic_ipstream.html#idm45512231408304-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="basic_ipstream.html#idm45512231406752-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="basic_ipstream.html#idm45512231405184-bb"><span class="identifier">basic_ipstream</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45512231403456-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45512231400896-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45512231398768-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45512231396624-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="basic_ipstream.html#idm45512231428048-bb">public member functions</a></span>
  <a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">*</span> <a class="link" href="basic_ipstream.html#idm45512231427488-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idm45512231425760-bb"><span class="identifier">pipe</span></a><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idm45512231423632-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45512231421344-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span> <a class="link" href="basic_ipstream.html#idm45512231419904-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;&amp;</span> <a class="link" href="basic_ipstream.html#idm45512231418032-bb"><span class="identifier">pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="basic_ipstream.html#idm45512231416560-bb"><span class="identifier">is_open</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idm45512231415136-bb"><span class="identifier">open</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idm45512231414000-bb"><span class="identifier">open</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="basic_ipstream.html#idm45512231412176-bb"><span class="identifier">close</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id-1.3.31.9.18.3.4"></a><h2>Description</h2>
<p>Implementation of a reading pipe stream. </p>
<div class="refsect2">
<a name="id-1.3.31.9.18.3.4.3"></a><h3>
<a name="boost.process.basic_ipstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_ipstream</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idm45512231410864-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. </li>
<li class="listitem">
<pre class="literallayout"><a name="idm45512231410288-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy constructor. </li>
<li class="listitem">
<pre class="literallayout"><a name="idm45512231408304-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>Move constructor. </li>
<li class="listitem">
<pre class="literallayout"><a name="idm45512231406752-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Move construct from a pipe. </li>
<li class="listitem">
<pre class="literallayout"><a name="idm45512231405184-bb"></a><span class="identifier">basic_ipstream</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Copy construct from a pipe. </li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a name="idm45512231403456-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre>Copy assignment. </li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a name="idm45512231400896-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>Move assignment. </li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a name="idm45512231398768-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Move assignment of a pipe. </li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_ipstream.html" title="Class template basic_ipstream">basic_ipstream</a> <span class="special">&amp;</span> <a name="idm45512231396624-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Copy assignment of a pipe. </li>
</ol></div>
</div>
<div class="refsect2">
<a name="id-1.3.31.9.18.3.4.4"></a><h3>
<a name="idm45512231428048-bb"></a><code class="computeroutput">basic_ipstream</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_pipebuf.html" title="Struct template basic_pipebuf">basic_pipebuf</a><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">*</span> <a name="idm45512231427488-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get access to the underlying stream_buf. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idm45512231425760-bb"></a><span class="identifier">pipe</span><span class="special">(</span><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idm45512231423632-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>Set the pipe of the streambuf. </li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span> <a name="idm45512231421344-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get a reference to the pipe. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;</span> <a name="idm45512231419904-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get a const reference to the pipe. </li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_ipstream.html#boost.process.basic_ipstream.pipe_type">pipe_type</a> <span class="special">&amp;&amp;</span> <a name="idm45512231418032-bb"></a><span class="identifier">pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Get a rvalue reference to the pipe. Qualified as rvalue. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45512231416560-bb"></a><span class="identifier">is_open</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Check if the pipe is open. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idm45512231415136-bb"></a><span class="identifier">open</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Open a new pipe. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idm45512231414000-bb"></a><span class="identifier">open</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> name<span class="special">)</span><span class="special">;</span></pre>Open a new named pipe. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idm45512231412176-bb"></a><span class="identifier">close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Flush the buffer &amp; close the pipe. </li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
      Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 2016 Klemens D. Morgenstern<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="std_err.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_opstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
